Skip to main content

sc.util

The utility Module for the computer API!

Functions​

positiveModulo​

sc.util.positiveModulo( x, n )

Reimplementation of sm.util.positiveModule

Arguments:

  • x [ integer ] The number.
  • n [ integer ] The modulo value.

Returns:

  • [ number ] The value.

generateNumberGradient​

sc.util.generateNumberGradient( numbers, numNumbers )

This generates an interpolated gradient between the numbers provided and is dependent on the ammount of gradient specified.

Arguments:

  • numbers [ number[] ] The table of numbers to generate the gradient from.
  • numNumbers [ integer ] The ammount of blending each number gets in the gradient table.

Returns:

  • [ number[] ] The generated gradient table.

mapValue​

sc.util.mapValue( value, fromMin, fromMax, toMin, toMax )

Maps a value from rangeA (fromMin & fromMax) to rangeB (toMin & toMax).

Arguments:

  • value [ number ] The number to map.
  • fromMin [ number ] The old mininum range.
  • fromMax [ number ] The old max range.
  • toMin [ number ] The new mininum range.
  • toMax [ number ] The new max range.

Returns:

  • [ number ] The mapped value.

setmetatable​

sc.util.setmetatable( tbl, metatable )

Reimplementation of LUA's set metatable function.

Arguments:

  • tbl [ table ] The table to modify.
  • metatable [ table ] The metatable data to set to the given table.

Returns:

  • [ table ] The modified table.

getmetatable​

sc.util.getmetatable( tbl )

Returns the metatable data of a table.

Arguments:

  • tbl [ table ] The table to retreive the data from.

Returns:

  • [ table ] The metatable data.

rpairs​

sc.util.rpairs( tbl )

Applies the rpairs algorithm to a table.

Arguments:

  • tbl [ table ] The table to modify.

Returns:

  • [ function ] The rpairs applied function.

round​

sc.util.round( number, dp )

Rounds a value with a given decimal point.

Arguments:

  • number [ number ] The number to round.
  • dp [ number ] The decimal point to round to (1 is 0.1, 2 is 0.01 etc).

Returns:

  • [ number ] The rounded number.